home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / lib / include / rpc / svc.h < prev    next >
Encoding:
C/C++ Source or Header  |  1989-01-25  |  8.5 KB  |  278 lines
  1. /* @(#)svc.h    1.2 87/11/09 3.9 RPCSRC */
  2. /*
  3.  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  4.  * unrestricted use provided that this legend is included on all tape
  5.  * media and as a part of the software program in whole or part.  Users
  6.  * may copy or modify Sun RPC without charge, but are not authorized
  7.  * to license or distribute it to anyone else except as part of a product or
  8.  * program developed by the user.
  9.  * 
  10.  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11.  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12.  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13.  * 
  14.  * Sun RPC is provided with no support and without any obligation on the
  15.  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16.  * modification or enhancement.
  17.  * 
  18.  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19.  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20.  * OR ANY PART THEREOF.
  21.  * 
  22.  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23.  * or profits or other special, indirect and consequential damages, even if
  24.  * Sun has been advised of the possibility of such damages.
  25.  * 
  26.  * Sun Microsystems, Inc.
  27.  * 2550 Garcia Avenue
  28.  * Mountain View, California  94043
  29.  */
  30. /*      @(#)svc.h 1.18 87/07/14 SMI      *
  31.  
  32. /*
  33.  * svc.h, Server-side remote procedure call interface.
  34.  *
  35.  * Copyright (C) 1984, Sun Microsystems, Inc.
  36.  */
  37.  
  38. #ifndef __SVC_HEADER__
  39. #define __SVC_HEADER__
  40.  
  41. /*
  42.  * This interface must manage two items concerning remote procedure calling:
  43.  *
  44.  * 1) An arbitrary number of transport connections upon which rpc requests
  45.  * are received.  The two most notable transports are TCP and UDP;  they are
  46.  * created and registered by routines in svc_tcp.c and svc_udp.c, respectively;
  47.  * they in turn call xprt_register and xprt_unregister.
  48.  *
  49.  * 2) An arbitrary number of locally registered services.  Services are
  50.  * described by the following four data: program number, version number,
  51.  * "service dispatch" function, a transport handle, and a boolean that
  52.  * indicates whether or not the exported program should be registered with a
  53.  * local binder service;  if true the program's number and version and the
  54.  * port number from the transport handle are registered with the binder.
  55.  * These data are registered with the rpc svc system via svc_register.
  56.  *
  57.  * A service's dispatch function is called whenever an rpc request comes in
  58.  * on a transport.  The request's program and version numbers must match
  59.  * those of the registered service.  The dispatch function is passed two
  60.  * parameters, struct svc_req * and SVCXPRT *, defined below.
  61.  */
  62.  
  63. enum xprt_stat {
  64.     XPRT_DIED,
  65.     XPRT_MOREREQS,
  66.     XPRT_IDLE
  67. };
  68.  
  69. /*
  70.  * Server side transport handle
  71.  */
  72. typedef struct {
  73.     int        xp_sock;
  74.     u_short        xp_port;     /* associated port number */
  75.     struct xp_ops {
  76.         bool_t    (*xp_recv)();     /* receive incomming requests */
  77.         enum xprt_stat (*xp_stat)(); /* get transport status */
  78.         bool_t    (*xp_getargs)(); /* get arguments */
  79.         bool_t    (*xp_reply)();     /* send reply */
  80.         bool_t    (*xp_freeargs)();/* free mem allocated for args */
  81.         void    (*xp_destroy)(); /* destroy this struct */
  82.     } *xp_ops;
  83.     int        xp_addrlen;     /* length of remote address */
  84.     struct sockaddr_in xp_raddr;     /* remote address */
  85.     struct opaque_auth xp_verf;     /* raw response verifier */
  86.     caddr_t        xp_p1;         /* private */
  87.     caddr_t        xp_p2;         /* private */
  88. } SVCXPRT;
  89.  
  90. /*
  91.  *  Approved way of getting address of caller
  92.  */
  93. #define svc_getcaller(x) (&(x)->xp_raddr)
  94.  
  95. /*
  96.  * Operations defined on an SVCXPRT handle
  97.  *
  98.  * SVCXPRT        *xprt;
  99.  * struct rpc_msg    *msg;
  100.  * xdrproc_t         xargs;
  101.  * caddr_t         argsp;
  102.  */
  103. #define SVC_RECV(xprt, msg)                \
  104.     (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
  105. #define svc_recv(xprt, msg)                \
  106.     (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
  107.  
  108. #define SVC_STAT(xprt)                    \
  109.     (*(xprt)->xp_ops->xp_stat)(xprt)
  110. #define svc_stat(xprt)                    \
  111.     (*(xprt)->xp_ops->xp_stat)(xprt)
  112.  
  113. #define SVC_GETARGS(xprt, xargs, argsp)            \
  114.     (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
  115. #define svc_getargs(xprt, xargs, argsp)            \
  116.     (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
  117.  
  118. #define SVC_REPLY(xprt, msg)                \
  119.     (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
  120. #define svc_reply(xprt, msg)                \
  121.     (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
  122.  
  123. #define SVC_FREEARGS(xprt, xargs, argsp)        \
  124.     (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
  125. #define svc_freeargs(xprt, xargs, argsp)        \
  126.     (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
  127.  
  128. #define SVC_DESTROY(xprt)                \
  129.     (*(xprt)->xp_ops->xp_destroy)(xprt)
  130. #define svc_destroy(xprt)                \
  131.     (*(xprt)->xp_ops->xp_destroy)(xprt)
  132.  
  133.  
  134. /*
  135.  * Service request
  136.  */
  137. struct svc_req {
  138.     u_long        rq_prog;    /* service program number */
  139.     u_long        rq_vers;    /* service protocol version */
  140.     u_long        rq_proc;    /* the desired procedure */
  141.     struct opaque_auth rq_cred;    /* raw creds from the wire */
  142.     caddr_t        rq_clntcred;    /* read only cooked cred */
  143.     SVCXPRT    *rq_xprt;        /* associated transport */
  144. };
  145.  
  146.  
  147. /*
  148.  * Service registration
  149.  *
  150.  * svc_register(xprt, prog, vers, dispatch, protocol)
  151.  *    SVCXPRT *xprt;
  152.  *    u_long prog;
  153.  *    u_long vers;
  154.  *    void (*dispatch)();
  155.  *    int protocol;  /* like TCP or UDP, zero means do not register 
  156.  */
  157. extern bool_t    svc_register();
  158.  
  159. /*
  160.  * Service un-registration
  161.  *
  162.  * svc_unregister(prog, vers)
  163.  *    u_long prog;
  164.  *    u_long vers;
  165.  */
  166. extern void    svc_unregister();
  167.  
  168. /*
  169.  * Transport registration.
  170.  *
  171.  * xprt_register(xprt)
  172.  *    SVCXPRT *xprt;
  173.  */
  174. extern void    xprt_register();
  175.  
  176. /*
  177.  * Transport un-register
  178.  *
  179.  * xprt_unregister(xprt)
  180.  *    SVCXPRT *xprt;
  181.  */
  182. extern void    xprt_unregister();
  183.  
  184.  
  185.  
  186.  
  187. /*
  188.  * When the service routine is called, it must first check to see if it
  189.  * knows about the procedure;  if not, it should call svcerr_noproc
  190.  * and return.  If so, it should deserialize its arguments via 
  191.  * SVC_GETARGS (defined above).  If the deserialization does not work,
  192.  * svcerr_decode should be called followed by a return.  Successful
  193.  * decoding of the arguments should be followed the execution of the
  194.  * procedure's code and a call to svc_sendreply.
  195.  *
  196.  * Also, if the service refuses to execute the procedure due to too-
  197.  * weak authentication parameters, svcerr_weakauth should be called.
  198.  * Note: do not confuse access-control failure with weak authentication!
  199.  *
  200.  * NB: In pure implementations of rpc, the caller always waits for a reply
  201.  * msg.  This message is sent when svc_sendreply is called.  
  202.  * Therefore pure service implementations should always call
  203.  * svc_sendreply even if the function logically returns void;  use
  204.  * xdr.h - xdr_void for the xdr routine.  HOWEVER, tcp based rpc allows
  205.  * for the abuse of pure rpc via batched calling or pipelining.  In the
  206.  * case of a batched call, svc_sendreply should NOT be called since
  207.  * this would send a return message, which is what batching tries to avoid.
  208.  * It is the service/protocol writer's responsibility to know which calls are
  209.  * batched and which are not.  Warning: responding to batch calls may
  210.  * deadlock the caller and server processes!
  211.  */
  212.  
  213. extern bool_t  svc_sendreply();
  214. extern void    svcerr_decode();
  215. extern void    svcerr_weakauth();
  216. extern void    svcerr_noproc();
  217.  
  218. /*
  219.  * Lowest level dispatching -OR- who owns this process anyway.
  220.  * Somebody has to wait for incoming requests and then call the correct
  221.  * service routine.  The routine svc_run does infinite waiting; i.e.,
  222.  * svc_run never returns.
  223.  * Since another (co-existant) package may wish to selectively wait for
  224.  * incoming calls or other events outside of the rpc architecture, the
  225.  * routine svc_getreq is provided.  It must be passed readfds, the
  226.  * "in-place" results of a select system call (see select, section 2).
  227.  */
  228.  
  229. /*
  230.  * Global keeper of rpc service descriptors in use
  231.  * dynamic; must be inspected before each call to select 
  232.  */
  233. #ifdef FD_SETSIZE
  234. extern fd_set svc_fdset;
  235. #define svc_fds svc_fdset.fds_bits[0]    /* compatibility */
  236. #else
  237. extern int svc_fds;
  238. #endif /* def FD_SETSIZE */
  239.  
  240. /*
  241.  * a small program implemented by the svc_rpc implementation itself;
  242.  * also see clnt.h for protocol numbers.
  243.  */
  244. extern void rpctest_service();
  245.  
  246. extern void    svc_getreq();
  247. extern void    svc_getreqset();    /* takes fdset instead of int */
  248. extern void    svc_run();      /* never returns */
  249.  
  250. /*
  251.  * Socket to use on svcxxx_create call to get default socket
  252.  */
  253. #define    RPC_ANYSOCK    -1
  254.  
  255. /*
  256.  * These are the existing service side transport implementations
  257.  */
  258.  
  259. /*
  260.  * Memory based rpc for testing and timing.
  261.  */
  262. extern SVCXPRT *svcraw_create();
  263.  
  264. /*
  265.  * Udp based rpc.
  266.  */
  267. extern SVCXPRT *svcudp_create();
  268. extern SVCXPRT *svcudp_bufcreate();
  269.  
  270. /*
  271.  * Tcp based rpc.
  272.  */
  273. extern SVCXPRT *svctcp_create();
  274.  
  275.  
  276.  
  277. #endif !__SVC_HEADER__
  278.